YIELDMAT
Returns the annual yield of a security that pays interest at maturity.
Syntax
expression.YIELDMAT(arg1, arg2, arg3, arg4, arg5, arg6);
expression - A variable that represents a ApiWorksheetFunction class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| arg1 | Required | ApiRange | ApiName | number |
| arg2 | Required | ApiRange | ApiName | number |
| arg3 | Required | ApiRange | ApiName | number |
| arg4 | Required | ApiRange | ApiName | number |
| arg5 | Required | ApiRange | ApiName | number |
| arg6 | Required | ApiRange | ApiName | number |
Returns
number
Example
var oWorksheet = Api.GetActiveSheet();
var oFunction = Api.GetWorksheetFunction();
oWorksheet.GetRange("A1").SetValue(oFunction.YIELDMAT("1/10/2018", "11/20/2019", "1/1/2017", "6.00%", 90));